Prepare for the 1.0 release #72
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This package needs rethinking, so it is better not to ship it in v1.0.0. Signed-off-by: Leandro Lucarella <[email protected]>
github-actions
bot
added
part:docs
github-actions
bot
added
the
part:tooling
There was a problem hiding this comment.
Pull Request Overview
Prepare for the 1.0 release by stripping out the experimental asyncio package, generalizing the module-name helper, finalizing the epoch constant, and updating release notes and label configs
- Remove all
asyncioutilities and their tests to avoid shipping unstable code - Rename
get_public_loggertoget_public_module_nameand adjust its implementation and tests - Annotate
UNIX_EPOCHas aFinalconstant - Update
RELEASE_NOTES.mdand GitHub labeler configs with new components
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_module.py | Updated import and assertions to use get_public_module_name |
| tests/asyncio/* | Deleted all asyncio-related test files |
| src/frequenz/core/module.py | Renamed helper to get_public_module_name and rewrote docstring |
| src/frequenz/core/datetime.py | Marked UNIX_EPOCH as Final[datetime] |
| .github/labeler.yml / keylabeler.yml | Added new part:module and part:id labels |
| RELEASE_NOTES.md | Revised summary and component list |
Comments suppressed due to low confidence (3)
tests/test_module.py:26
- [nitpick] The test function name and its docstring still refer to
get_public_logger—please rename them (e.g.test_get_public_module_name) to match the updated helper.
def test_get_public_logger(module_name: str, expected_logger_name: str) -> None:
RELEASE_NOTES.md:5
- [nitpick] Consider mentioning the removal of the
asyncioutilities in this summary to inform users about backward-incompatible changes in the 1.0 release.
This is the initial release of the Frequenz Core Library, which provides a set of fundamental tools and utilities for Python.
RELEASE_NOTES.md:10
- [nitpick] List markers are inconsistent (mix of
-and*). Please use a consistent bullet style throughout.
* `id`: For creating unique system-wide ID types.
This module and function were too specific to `logging`, when it could be more generally useful if it just deal with module names instead. The module was renamed to `core.module` and the function to `get_public_module_name()`, and it now deals only with strings. When this is needed to get a logger, users can simply do: logger = logging.getLogger(module.get_public_module_name(__name__)) Signed-off-by: Leandro Lucarella <[email protected]>
This ensures it can't be re-bound to some other value. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
daniel-zullo-frequenz
approved these changes
Jun 6, 2025
Nah, we keep using what's in the SDK until we get it right. The code is there, we can always revert the commit if we want it back. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR removes the
asynciopackage, as it will probably need to change radically, so we don't want to ship it for 1.0.It also generalizes
logging.get_public_loggerto be about module names (so getting the public part of a module name instead of limit it to only work with loggers) and makesUNIX_EPOCHfinal.It also updates the release notes.